home *** CD-ROM | disk | FTP | other *** search
/ SGI Freeware 2002 November / SGI Freeware 2002 November - Disc 2.iso / dist / fw_guile.idb / usr / freeware / include / libguile / debug.h.z / debug.h
Encoding:
C/C++ Source or Header  |  2002-07-08  |  7.8 KB  |  229 lines
  1. /* classes: h_files */
  2.  
  3. #ifndef SCM_DEBUG_H
  4. #define SCM_DEBUG_H
  5. /* Copyright (C) 1995,1996,1998,1999,2000,2001 Free Software Foundation
  6.  * 
  7.  * This program is free software; you can redistribute it and/or modify
  8.  * it under the terms of the GNU General Public License as published by
  9.  * the Free Software Foundation; either version 2, or (at your option)
  10.  * any later version.
  11.  * 
  12.  * This program is distributed in the hope that it will be useful,
  13.  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14.  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15.  * GNU General Public License for more details.
  16.  * 
  17.  * You should have received a copy of the GNU General Public License
  18.  * along with this software; see the file COPYING.  If not, write to
  19.  * the Free Software Foundation, Inc., 59 Temple Place, Suite 330,
  20.  * Boston, MA 02111-1307 USA
  21.  *
  22.  * As a special exception, the Free Software Foundation gives permission
  23.  * for additional uses of the text contained in its release of GUILE.
  24.  *
  25.  * The exception is that, if you link the GUILE library with other files
  26.  * to produce an executable, this does not by itself cause the
  27.  * resulting executable to be covered by the GNU General Public License.
  28.  * Your use of that executable is in no way restricted on account of
  29.  * linking the GUILE library code into it.
  30.  *
  31.  * This exception does not however invalidate any other reasons why
  32.  * the executable file might be covered by the GNU General Public License.
  33.  *
  34.  * This exception applies only to the code released by the
  35.  * Free Software Foundation under the name GUILE.  If you copy
  36.  * code from other Free Software Foundation releases into a copy of
  37.  * GUILE, as the General Public License permits, the exception does
  38.  * not apply to the code that you add in this way.  To avoid misleading
  39.  * anyone as to the status of such modified files, you must delete
  40.  * this exception notice from them.
  41.  *
  42.  * If you write modifications of your own for GUILE, it is your choice
  43.  * whether to permit this exception to apply to your modifications.
  44.  * If you do not wish that, delete this exception notice.
  45.  *
  46.  * The author can be reached at djurfeldt@nada.kth.se
  47.  * Mikael Djurfeldt, SANS/NADA KTH, 10044 STOCKHOLM, SWEDEN */
  48.  
  49.  
  50.  
  51. #include "libguile/__scm.h"
  52.  
  53. #include "libguile/options.h"
  54.  
  55.  
  56. /*
  57.  * Here comes some definitions for the debugging machinery.
  58.  * It might seem strange to represent debug flags as ints,
  59.  * but consider that any particular piece of code is normally
  60.  * only interested in one flag at a time.  This is then
  61.  * the most efficient representation.
  62.  */
  63.  
  64. /* {Options}
  65.  */
  66.  
  67. /* scm_debug_opts is  defined in eval.c.
  68.  */
  69.  
  70. extern scm_t_option scm_debug_opts[];
  71.  
  72. #define SCM_CHEAPTRAPS_P    scm_debug_opts[0].val
  73. #define SCM_BREAKPOINTS_P    scm_debug_opts[1].val
  74. #define SCM_TRACE_P        scm_debug_opts[2].val
  75. #define SCM_REC_PROCNAMES_P    scm_debug_opts[3].val
  76. #define SCM_BACKWARDS_P        scm_debug_opts[4].val
  77. #define SCM_BACKTRACE_WIDTH       scm_debug_opts[5].val
  78. #define SCM_BACKTRACE_INDENT       scm_debug_opts[6].val
  79. #define SCM_N_FRAMES        scm_debug_opts[7].val
  80. #define SCM_BACKTRACE_MAXDEPTH    scm_debug_opts[8].val
  81. #define SCM_BACKTRACE_DEPTH    scm_debug_opts[9].val
  82. #define SCM_BACKTRACE_P        scm_debug_opts[10].val
  83. #define SCM_DEVAL_P        scm_debug_opts[11].val
  84. #define SCM_STACK_LIMIT        scm_debug_opts[12].val
  85. #define SCM_SHOW_FILE_NAME    scm_debug_opts[13].val
  86. #define SCM_N_DEBUG_OPTIONS 14
  87.  
  88. extern SCM (*scm_ceval_ptr) (SCM exp, SCM env);
  89.  
  90. extern int scm_debug_mode;
  91. extern int scm_check_entry_p, scm_check_apply_p, scm_check_exit_p;
  92.  
  93. #define CHECK_ENTRY      scm_check_entry_p
  94. #define CHECK_APPLY     scm_check_apply_p
  95. #define CHECK_EXIT       scm_check_exit_p
  96.  
  97. #define SCM_RESET_DEBUG_MODE \
  98. do {\
  99.   CHECK_ENTRY = (SCM_ENTER_FRAME_P || SCM_BREAKPOINTS_P)\
  100.     && SCM_NFALSEP (SCM_ENTER_FRAME_HDLR);\
  101.   CHECK_APPLY = (SCM_APPLY_FRAME_P || SCM_TRACE_P)\
  102.     && SCM_NFALSEP (SCM_APPLY_FRAME_HDLR);\
  103.   CHECK_EXIT = (SCM_EXIT_FRAME_P || SCM_TRACE_P)\
  104.     && SCM_NFALSEP (SCM_EXIT_FRAME_HDLR);\
  105.   scm_debug_mode = SCM_DEVAL_P || CHECK_ENTRY || CHECK_APPLY || CHECK_EXIT;\
  106.   scm_ceval_ptr = scm_debug_mode ? scm_deval : scm_ceval;\
  107. } while (0)
  108.  
  109. /* {Evaluator}
  110.  */
  111.  
  112. typedef union scm_t_debug_info
  113. {
  114.   struct { SCM exp, env; } e;
  115.   struct { SCM proc, args; } a;
  116.   SCM id;
  117. } scm_t_debug_info;
  118.  
  119. extern long scm_debug_eframe_size;
  120.  
  121. typedef struct scm_t_debug_frame
  122. {
  123.   struct scm_t_debug_frame *prev;
  124.   long status;
  125.   scm_t_debug_info *vect;
  126.   scm_t_debug_info *info;
  127. } scm_t_debug_frame;
  128.  
  129. #if (SCM_DEBUG_DEPRECATED == 0)
  130. # define scm_debug_info scm_t_debug_info
  131. # define scm_debug_frame scm_t_debug_frame
  132. #endif
  133.  
  134. #ifndef USE_THREADS
  135. extern scm_t_debug_frame *scm_last_debug_frame;
  136. #endif
  137.  
  138. #define SCM_EVALFRAME    (0L << 11)
  139. #define SCM_APPLYFRAME   (1L << 11)
  140. #define SCM_VOIDFRAME    (3L << 11)
  141. #define SCM_MACROEXPF    (1L << 10)
  142. #define SCM_TAILREC      (1L << 9)
  143. #define SCM_TRACED_FRAME (1L << 8)
  144. #define SCM_ARGS_READY   (1L << 7)
  145. #define SCM_DOVERFLOW    (1L << 6)
  146. #define SCM_MAX_FRAME_SIZE 63 /* also used as a mask for the size field */
  147.  
  148. #define SCM_FRAMETYPE    (3L << 11)
  149.  
  150. #define SCM_EVALFRAMEP(x) (((x).status & SCM_FRAMETYPE) == SCM_EVALFRAME)
  151. #define SCM_APPLYFRAMEP(x) (((x).status & SCM_FRAMETYPE) == SCM_APPLYFRAME)
  152. #define SCM_VOIDFRAMEP(x) (((x).status & SCM_FRAMETYPE) == SCM_VOIDFRAME)
  153. #define SCM_OVERFLOWP(x) (((x).status & SCM_DOVERFLOW) != 0)
  154. #define SCM_ARGS_READY_P(x) (((x).status & SCM_ARGS_READY) != 0)
  155. #define SCM_TRACED_FRAME_P(x) (((x).status & SCM_TRACED_FRAME) != 0)
  156. #define SCM_TAILRECP(x) (((x).status & SCM_TAILREC) != 0)
  157. #define SCM_MACROEXPP(x) (((x).status & SCM_MACROEXPF) != 0)
  158. #define SCM_SET_OVERFLOW(x) ((x).status |= SCM_DOVERFLOW)
  159. #define SCM_SET_ARGSREADY(x) ((x).status |= SCM_ARGS_READY)
  160. #define SCM_CLEAR_ARGSREADY(x) ((x).status &= ~SCM_ARGS_READY)
  161. #define SCM_SET_TRACED_FRAME(x) ((x).status |= SCM_TRACED_FRAME)
  162. #define SCM_CLEAR_TRACED_FRAME(x) ((x).status &= ~SCM_TRACED_FRAME)
  163. #define SCM_SET_TAILREC(x) ((x).status |= SCM_TAILREC)
  164. #define SCM_SET_MACROEXP(x) ((x).status |= SCM_MACROEXPF)
  165. #define SCM_CLEAR_MACROEXP(x) ((x).status &= ~SCM_MACROEXPF)
  166.  
  167. #define SCM_DEBUGGINGP scm_debug_mode
  168. #define SCM_DSIDEVAL(x, env) if NIMP(x) scm_deval((x), (env))
  169.  
  170. /* {Debug Objects}
  171.  */
  172.  
  173. extern scm_t_bits scm_tc16_debugobj;
  174.  
  175. #define SCM_DEBUGOBJP(x) \
  176.   SCM_TYP16_PREDICATE (scm_tc16_debugobj, x)
  177. #define SCM_DEBUGOBJ_FRAME(x) \
  178.   ((scm_t_debug_frame *) SCM_CELL_WORD_1 (x))
  179. #define SCM_SET_DEBUGOBJ_FRAME(x, f)  SCM_SET_CELL_WORD_1 (x, f)
  180.  
  181. /* {Memoized Source}
  182.  */
  183.  
  184. extern scm_t_bits scm_tc16_memoized;
  185.  
  186. #define SCM_MEMOIZEDP(x)    SCM_TYP16_PREDICATE (scm_tc16_memoized, x)
  187. #define SCM_MEMOIZED_EXP(x)    SCM_CAR (SCM_CELL_OBJECT_1 (x))
  188. #define SCM_MEMOIZED_ENV(x)    SCM_CDR (SCM_CELL_OBJECT_1 (x))
  189.  
  190.  
  191.  
  192. extern int scm_ready_p (void);
  193. extern void debug_print (SCM obj);
  194. extern SCM scm_debug_object_p (SCM obj);
  195. extern SCM scm_local_eval (SCM exp, SCM env);
  196. extern SCM scm_reverse_lookup (SCM env, SCM data);
  197. extern SCM scm_start_stack (SCM id, SCM exp, SCM env);
  198. extern SCM scm_procedure_environment (SCM proc);
  199. extern SCM scm_procedure_source (SCM proc);
  200. extern SCM scm_procedure_name (SCM proc);
  201. extern SCM scm_memoized_environment (SCM m);
  202. extern SCM scm_make_memoized (SCM exp, SCM env);
  203. extern SCM scm_memoized_p (SCM obj);
  204. extern SCM scm_with_traps (SCM thunk);
  205. extern SCM scm_evaluator_traps (SCM setting);
  206. extern SCM scm_debug_options (SCM setting);
  207. extern SCM scm_unmemoize (SCM memoized);
  208. extern SCM scm_make_debugobj (scm_t_debug_frame *debug);
  209. extern void scm_init_debug (void);
  210.  
  211. #ifdef GUILE_DEBUG
  212. extern SCM scm_make_gloc (SCM var, SCM env);
  213. extern SCM scm_gloc_p (SCM obj);
  214. extern SCM scm_make_iloc (SCM frame, SCM binding, SCM cdrp);
  215. extern SCM scm_iloc_p (SCM obj);
  216. extern SCM scm_memcons (SCM car, SCM cdr, SCM env);
  217. extern SCM scm_mem_to_proc (SCM obj);
  218. extern SCM scm_proc_to_mem (SCM obj);
  219. extern SCM scm_debug_hang (SCM obj);
  220. #endif /*GUILE_DEBUG*/
  221.  
  222. #endif /* SCM_DEBUG_H */
  223.  
  224. /*
  225.   Local Variables:
  226.   c-file-style: "gnu"
  227.   End:
  228. */
  229.